Platform Explorer / Nuxeo Platform 2023.22

Operation Directory.ReadEntries (Reads directory entries)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Reads directory entries. Entries ids to read are sent as a JSON array. Returns the entries as a JSON array of JSON objects containing all fields.
Operation id Directory.ReadEntries
Category Services
Label Reads directory entries
Requires
Since

Parameters

Name Description Type Required Default value
directoryName string yes  
entries string yes  
lang string no  
translateLabels boolean no  

Signature

Inputs void
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.directory.ReadDirectoryEntries
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Directory.ReadEntries",
  "label" : "Reads directory entries",
  "category" : "Services",
  "requires" : null,
  "description" : "Reads directory entries. Entries ids to read are sent as a JSON array. Returns the entries as a JSON array of JSON objects containing all fields.",
  "url" : "Directory.ReadEntries",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "directoryName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "entries",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lang",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "translateLabels",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}